Linc 1.0.0

Some description

Operations

  • PUB /{organisation_id}/nodes/{node_id}/channels/config

    Operation ID/{organisation_id}/nodes/{node_id}/channels/config
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/channels/config
    Message ID/{organisation_id}/nodes/{node_id}/channels/config
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/channels/data

    Operation ID/{organisation_id}/nodes/{node_id}/channels/data
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Bulk Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/channels/data
    Message ID/{organisation_id}/nodes/{node_id}/channels/data
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature

    Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

    Operation ID/{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature
    Message ID/{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature

    Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

    Operation ID/{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature
    Message ID/{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature

    Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

    Operation ID/{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature
    Message ID/{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature

    Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

    Operation ID/{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature
    Message ID/{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/device/config

    Parameters for identification, information and configuration of hardware devices.

    Operation ID/{organisation_id}/nodes/{node_id}/device/config
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/device/config
    Message ID/{organisation_id}/nodes/{node_id}/device/config
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/device/data

    Parameters for identification, information and configuration of hardware devices.

    Operation ID/{organisation_id}/nodes/{node_id}/device/data
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Bulk Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/device/data
    Message ID/{organisation_id}/nodes/{node_id}/device/data
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode

    Choice of data handling strategy for a Linc node, influencing both how the data is processed and the associated costs.

    Operation ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode
    Message ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval

    The frequency at which a Linc node sends data, determining how often updates or readings are provided.

    Operation ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval
    Message ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/device/linc/fw_version

    The software revision number associated with a Linc node, reflecting updates, enhancements, or fixes.

    Operation ID/{organisation_id}/nodes/{node_id}/device/linc/fw_version
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/device/linc/fw_version
    Message ID/{organisation_id}/nodes/{node_id}/device/linc/fw_version
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/device/linc/label

    User-specified name or identifier for a Linc node, allowing for easy differentiation within a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/device/linc/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/device/linc/label
    Message ID/{organisation_id}/nodes/{node_id}/device/linc/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label

    User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase

    The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity

    Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating

    Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor

    Specifies the model of current sensor installed for measurements.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current

    Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd

    TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms

    Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum

    Representation of current RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental

    THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms

    THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak

    Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported

    Energy sent back to the grid. Can generate credits or offset costs.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported

    Energy drawn from the grid. Directly impacts electricity bills.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net

    Total active energy produced minus consumed.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported

    Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported

    Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net

    Total apparent energy produced minus consumed. Useful for system capacity planning.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported

    Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported

    Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net

    Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active

    Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent

    Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement

    Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion

    Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total

    The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive

    Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous

    The number of cycles per second in an alternating current (AC) system, measured in Hertz (Hz).

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal

    The standard frequency at which the electrical grid is designed to operate, typically 50 Hz or 60 Hz in various regions.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range

    The continuous frequency range equally above and below the designated grid nominal frequency. A value of 500 mHz would imply a 49.5 to 50.5 Hz nominal range (for a 50 Hz system).

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient

    Transient values in grid frequency at 200ms intervals correspond to 10 cycles in a 50 Hz system and 12 cycles in a 60 Hz system. These brief deviations are vital for electrical grid stability.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal

    Nominal voltage refers to the standard voltage level defined for single or three-phase systems, typically expressed in root mean square (RMS) terms. It represents the voltage that the system is designed to operate at under normal conditions.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits

    Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms

    Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum

    Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental

    THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms

    THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak

    Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits

    Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms

    Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum

    Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental

    THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms

    THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak

    Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor

    Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits

    Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms

    Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum

    Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental

    THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms

    THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak

    Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor

    Voltage Unbalance Factor (VUF) in a three-phase system quantifies the deviation among the RMS values of the three phases. It is calculated as the ratio of the maximum deviation from the average voltage to the average voltage itself, expressed as a percentage. Higher VUF values indicate a greater imbalance in the system.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor
    Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/config

    Parameters related to electrical systems.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/config
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/config
    Message ID/{organisation_id}/nodes/{node_id}/electrical/config
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/electrical/data

    Parameters related to electrical systems.

    Operation ID/{organisation_id}/nodes/{node_id}/electrical/data
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Bulk Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/electrical/data
    Message ID/{organisation_id}/nodes/{node_id}/electrical/data
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid

    The ICCID (Integrated Circuit Card Identifier) is a unique serial number assigned to each SIM card used in mobile devices. Typically 19 to 20 digits long, it's used to identify the SIM internationally, helping operators and service providers manage their subscribers. The ICCID provides information about the card's origin, network, and other specific details.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid
    Payload
    string
    must match: /^[0-9]{18,22}$/

    The ICCID (Integrated Circuit Card Identifier) is a unique serial number assigned to each SIM card used in mobile devices. Typically 19 to 20 digits long, it's used to identify the SIM internationally, helping operators and service providers manage their subscribers. The ICCID provides information about the card's origin, network, and other specific details.

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc

    The MCC (Mobile Country Code) is a three-digit number used to identify a mobile device's country of origin or the country of the cellular network it's operating in. It's a component of the IMSI (International Mobile Subscriber Identity) and is essential for international roaming, ensuring the device can connect to networks outside its home country.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc
    Payload
    string
    must match: /^[0-9]{3}$/

    The MCC (Mobile Country Code) is a three-digit number used to identify a mobile device's country of origin or the country of the cellular network it's operating in. It's a component of the IMSI (International Mobile Subscriber Identity) and is essential for international roaming, ensuring the device can connect to networks outside its home country.

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc

    The MNC (Mobile Network Code) is a two or three-digit number used in conjunction with the Mobile Country Code (MCC) to identify a specific mobile network operator within a country. Together, the MCC and MNC form a unique identifier for cellular networks, allowing devices to connect to the correct local network and ensuring proper routing of communications, especially in international roaming scenarios.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc
    Payload
    string
    must match: /^[0-9]{2,3}$/

    The MNC (Mobile Network Code) is a two or three-digit number used in conjunction with the Mobile Country Code (MCC) to identify a specific mobile network operator within a country. Together, the MCC and MNC form a unique identifier for cellular networks, allowing devices to connect to the correct local network and ensuring proper routing of communications, especially in international roaming scenarios.

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin

    The MSIN (Mobile Subscription Identification Number) is a unique number typically consisting of 9 to 10 digits, representing an individual subscriber in a mobile network. It's the last part of the IMSI (International Mobile Subscriber Identity) and, when combined with the MCC (Mobile Country Code) and MNC (Mobile Network Code), creates a unique identifier for each mobile user globally. MSIN ensures individual subscribers are distinguished within a specific network operator's service.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin
    Payload
    string
    must match: /^[0-9]{10}$/

    The MSIN (Mobile Subscription Identification Number) is a unique number typically consisting of 9 to 10 digits, representing an individual subscriber in a mobile network. It's the last part of the IMSI (International Mobile Subscriber Identity) and, when combined with the MCC (Mobile Country Code) and MNC (Mobile Network Code), creates a unique identifier for each mobile user globally. MSIN ensures individual subscribers are distinguished within a specific network operator's service.

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/mode

    Cellular modes like Cat M1, Cat NB2 refer to different categories of 4G (LTE) and 5G technologies.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/mode
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/connection/mode
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/mode
    string oneOf

    Cellular modes like Cat M1, Cat NB2 refer to different categories of 4G (LTE) and 5G technologies.

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/status

    The connection status refers to whether or not a connection is enabled.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/status
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/connection/status
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/status
    string oneOf

    The connection status refers to whether or not a connection is enabled.

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp

    RSRP (Reference Signal Received Power) gauges the power level of specific LTE reference signals in dBm. Closer to -80 dBm signifies a strong signal, while figures around -100 dBm indicate weak ones. RSRP helps determine LTE cell coverage and connection robustness.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp
    array<array<any>>

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq

    RSRQ (Reference Signal Received Quality) evaluates the quality of LTE reference signals by comparing the received power of a reference signal to the total received power. A value closer to -10 dB suggests superior signal quality, while values nearing -20 dB indicate poorer quality. RSRQ helps understand the LTE signal's relative quality in the context of surrounding interference.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq
    array<array<any>>

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi

    RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi
    array<array<any>>

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr

    SINR (Signal-to-Interference-plus-Noise Ratio) contrasts the power of a desired signal against the combined power of interference and noise, represented in dB. Higher values, like 20 dB, suggest a better signal quality, whereas values close to 0 dB suggest a compromised signal due to interference. SINR helps gauge LTE connection clarity.

    Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr
    Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr
    array<array<any>>

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/config

    Parameters related to connectivity and network protocols.

    Operation ID/{organisation_id}/nodes/{node_id}/network/config
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Config

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/config
    Message ID/{organisation_id}/nodes/{node_id}/network/config
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/connectivity/status

    The connection status shows whether or not a device is currently online.

    Operation ID/{organisation_id}/nodes/{node_id}/network/connectivity/status
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/connectivity/status
    Message ID/{organisation_id}/nodes/{node_id}/network/connectivity/status
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h

    Moving average of the device uptime in the past 6 hours.

    Operation ID/{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h
    Message ID/{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/data

    Parameters related to connectivity and network protocols.

    Operation ID/{organisation_id}/nodes/{node_id}/network/data
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Bulk Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/data
    Message ID/{organisation_id}/nodes/{node_id}/network/data
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count

    Hop count in a mesh network refers to the number of intermediate nodes that data must pass through between its originating node and the root node with internet access. It serves as a metric to determine the path's length and potential latency. As the hop count increases, it can impact the overall bandwidth availability and network efficiency due to increased chances of congestion and interference.

    Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count
    Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address

    An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

    Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address
    Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node

    Parent node in a mesh network refers to an immediate upstream node to which another node (typically referred to as the child node) is directly connected. The parent node helps the child node with tasks like routing data, establishing connectivity, or maintaining the network hierarchy within the mesh topology.

    Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node
    Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status

    The connection status refers to whether or not a connection is enabled.

    Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status
    Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi

    RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

    Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi
    Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address

    An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

    Operation ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address
    Message ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/wifi/connection/status

    The connection status refers to whether or not a connection is enabled.

    Operation ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/status
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/wifi/connection/status
    Message ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/status
    oneOf

    Examples

  • PUB /{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi

    RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

    Operation ID/{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi
    node_id
    required
    string
    must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

    Some description

    organisation_id
    required
    string
    format: uuiduid: organisation_id

    Some description

    • #Granular Data

    Accepts the following message:

    /{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi
    Message ID/{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi
    oneOf

    Examples

Schemas

  • object
    uid: data_models
  • object
    uid: properties

    abc